Implement docs for ufunc. Update docs for logic element-wise functions. #1967
+485
−83
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
View rendered docs @ https://intelpython.github.io/dpnp/pull/1967/index.html |
antonwolfy
reviewed
Aug 16, 2024
| @@ -5,7 +5,49 @@ Universal Functions (ufunc) | |||
|
|
|||
| .. https://docs.scipy.org/doc/numpy/reference/ufuncs.html | |||
|
|
|||
| DPNP provides universal functions (a.k.a. ufuncs) to support various element-wise operations. | |||
| A universal function (or ufunc for short) is a function that operates on ndarrays in an element-by-element fashion, \ | |||
There was a problem hiding this comment.
Why do we need \ here? Is it helps somehow to format the output? (and in what way?)
I don't see that we used it previously somewhere and so wonder why do we need it here.
| wrapper for a function that takes a fixed number of specific inputs and produces a fixed number of specific outputs. \ | ||
| For full documentation refer to :obj:`numpy.ufunc`. | ||
|
|
||
| ufuncs |
There was a problem hiding this comment.
Can we put here a link to :class:ufunc like in numpy with more detailed description of the attributes?
| :toctree: generated/ | ||
|
|
||
| dpnp.ufunc | ||
|
|
There was a problem hiding this comment.
What if about Optional keyword arguments section present in numpy? Should we add it also?
|
|
||
| Attributes | ||
| ~~~~~~~~~~ | ||
|
|
There was a problem hiding this comment.
Do we need to specify index directive? (applicable to different place on the page)
.. index::
pair: ufunc; attributes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is first PR from updating docs for element-wise functions.
Implement docs for ufunc.
Update docs for logic element-wise functions.